Export: PPAs CSV

Export: PPAs CSV (EXPPPA via script) is a system-level command that triggers the FMS to export prior period adjustment records for a defined time range as a .csv file. In this way, the service can gather all the "pending" prior period adjustments (PPAs) that were created on or after the specified date, and export them as a .csv file to a specified directory location. You will be able to optionally mark the records as "Exported" to indicate that they have been handled.

Eligible records include PPAs generated for Station Group Nodes, Gas Device Nodes configured to also act as stations, and Liquid Device Nodes with support for periodic metering data.

You must have proper security authorization to execute this command. See FMS Security (and CMDSYS security event) for information about configuring security access for FMS commands.

See Configuring File Export Commands: PPAs CSV and Running PPA Export Commands for more information about using this command via FMS Explorer.

See Scheduling FMS Command Tasks in the MSS for more information about scheduling commands.

See FMS ActiveX Controls and CxHmiFms for more information about using commands via FMS ActiveX controls on CygNet Studio or CygNet Vision screens.

See CxFms for more information about scripting commands.

Command Definition Properties

The following command definition properties apply to Export: PPAs CSV commands, when scheduling, creating, or editing commands via CygNet Explorer.

Property	Description
FMS service	Select a Site.Service for the command from the available FMS service list in the drop-down menu.
Command	Select the desired Command name from the drop-down menu. See FMS Commands for more information about available command types.
Priority	Select a processing queue Priority for the command from the drop-down menu. Options from least to greatest priority are as follows. Low level Medium level High level User initiated transaction Admin initiated transaction Default value is Low level processing queue priority.
Logging	Select a Logging level for the command results from the drop-down menu. Options are as follows. Low — displays errors Medium — displays errors and warnings High — displays errors, warnings, and status Default value is Low level logging when scheduling a command via the MSS in CygNet Explorer. Default value is High level logging when creating or running an ad-hoc command in FMS Explorer or via the FMS in CygNet Explorer.

Command Parameters

The following command parameters apply to Export: PPAs CSV commands, when scheduling, creating, or editing commands via CygNet Explorer or scripting.

Parameter	Description	Type	Usage Notes
PPABeginT	Start date of PPA records to retrieve	Date	Double-click to access the Select Start Date of PPA Records to Retrieve dialog box. Select the starting date of the time range for which to retrieve records. See Selecting Date and Time for more information. See Notes * below this table. This parameter is required.
PPAEndT	End date of PPA records to retrieve	Date	Double-click to access the Select End Date of PPA Records to Retrieve dialog box. Select the ending date of the time range for which to retrieve records. See Selecting Date and Time for more information. See Notes * below this table. This parameter is required.
PPAFileDirPath	Directory to export CSV file	File Directory	Double-click to access the Enter Directory to Export CSV File dialog box. Type the directory location for the file into the text box or click ... to access the Browse for Folder dialog box, browse to the directory location. Note: The directory specified is relative to the computer hosting the FMS. See Notes ** below this table. This parameter is required.
PPAFileNm	Name of CSV export file	String	Double-click to access the Select Name of CSV Export File dialog box. Type a file name into the text box and/or use tokens to define a CSV export file name. See Notes *** below this table. This parameter is required.
ExFileNm	Data exported flag	String Enum	Double-click to access the Data Exported Flag dialog box. Select whether or not to use the flag to mark exported device records in the database. Options are as follows. Ignore flag (IgnFlg via script) Use flag (UseFlg via script) This parameter is required.

Defining a CSV Export File Name

You can use text, tokens, or both, to define a CSV export file name in the MSS. A token is a text string enclosed by percent signs (%sampletext%), that represents a described value. The token will be replaced with the value it represents. Tokens are used several places in CygNet Software to define dynamic text substitutions, as described for the specific usage.

To Define a CSV Export File Name in the MSS

1. Double-click the Name of CSV export file parameter to access the Select Name of CSV Export File dialog box.

Select Name of CSV Export File

2. Enter a file name using one of the following methods.

1. Type the file name directly into the text box.
2. Use tokens to define the file name. Acceptable token string options appear in the list box. Double-click a token name to add it to the file name in the text box. Repeat for all desired tokens. Cut and paste to alter token order, if desired.
3. Use tokens in conjunction with typed text to define the file name. Text can be located before, between, or after tokens.

3. Click OK when you are done.